Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert "[Doc] Turn on nitpicky mode" #46241

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

can-anyscale
Copy link
Collaborator

Reverts #46103

@can-anyscale can-anyscale requested a review from a team as a code owner June 25, 2024 02:54
@can-anyscale can-anyscale merged commit 70a8152 into master Jun 25, 2024
2 of 5 checks passed
@can-anyscale can-anyscale deleted the revert-46103-39658-turn-on-nitpicky-mode branch June 25, 2024 02:55
peytondmurray added a commit to peytondmurray/ray that referenced this pull request Jun 26, 2024
This reverts commit 70a8152.

Signed-off-by: pdmurray <peynmurray@gmail.com>
can-anyscale pushed a commit that referenced this pull request Jun 27, 2024
## Why are these changes needed?

This PR fixes a broken link and type annotation in Ray Train, and
re-enables nitpicky mode in the docs.

There were two issues affecting the documentation:

1. The autosummary of `ray.data.dataset.Schema` was incorrectly
referencing `ray.data.Schema`
2. The docstring of `Schema` contained entries (`types` and `names`)
under the `Attribute` section which were already documented using
docstrings of their respective properties. The build error that you get
when you build the documentation unhelpfully suggested using `noindex`,
but instead we just need to either use the docstrings in `Attributes` or
the docstrings under the property methods, not both.

## Related issue number

Reverts #46241. Blocked by #46280.

Signed-off-by: pdmurray <peynmurray@gmail.com>
Signed-off-by: Peyton Murray <peynmurray@gmail.com>
Co-authored-by: Balaji Veeramani <bveeramani@berkeley.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant